Back
Moderated Orders XML - Integration Guide for Moderated Orders

Modified on 2013/08/28 15:44 by trushwin Categorized as Uncategorized
==MODERATED ORDERS XML - INTEGRATION GUIDE FOR MODERATED ORDERS==

'''__THE FOLLOWING INFORMATION DESCRIBES A FUTURE FEATURE IN DEVELOPMENT. THE FINAL SPECIFICATION IS SUBJECT TO CHANGE.__
'''


===Overview===

Cafepress Services (CP) supports moderating, or reviewing, an order's images prior to fulfillment. 

===Moderation Integration Tasks===

====1.  Indicate which items to moderate within your submitted orders.====
The orders utilize our [XML-Specifications | standard XML order specification] with values in specific elements and attributes. This document highlights the relevant required/optional values and provides sample XML for the moderated order scenarios.

The following moderation levels are supported:

* <b>Partner</b> - moderate all orders' images sent.  To setup or change this moderation level, please contact your account manager.
* <b>Partner/Product</b> - moderate all orderlines which contain a specific product.  To setup or change this moderation level, please contact your account manager.
* <b>Order</b> - moderate all of a single order's images.  
* <b>Orderline</b> - moderate all images associated with a single orderline in a single order.
* <b>Image/Asset</b> - moderate a single image, which is associated with one or more orderlines in a single order.
* <b>Builder Project</b> - for Builder integrations, moderate one or more images located in the Project XML.


====2. Receive [Event-Notifications | events notifications] regarding the moderation process for orders.====

The following events are available to help monitor the moderation process, and determine when your input is necessary to complete the moderation process:

* <b>ModerationStarted</b> -  Indicates that a moderated order has started the moderation process.
* <b>ModerationPending</b> - Indicates that a moderated order's image has been marked as pending for review purposes.
* <b>ModerationComplete</b> - Indicates that a moderated order has completed the moderation process. Contains orderline-level status information regarding if associated images have been 'Passed' or 'Rejected' in the moderation process. 'Rejected' orderlines indicate a reason code.
* <b>Canceled</b> - As a result of moderation, the entire order or part of an order may be cancelled.   


For more details, please see the [Event-Notifications | events notifications] documentation.



===Moderation Level 'Order' Sample XML===
Moderate all of a single order's images.  The sample below is a partial listing of the [XML-Specifications | standard order XML].

<pre><esc>
<?xml version="1.0" encoding="UTF-8"?>
<orders partnerid="xxxxx" version="1">
...
	<ordersession>
		<order>
			<orderid>1234</orderid>
			...
			<orderline productid = "10050" imageid = "5">
				<description>5x7 Glossy Print</description>
				<productprice>1.95</productprice>
				<quantity>1</quantity>
				<position>fit</position>
			</orderline>
			...
			<moderate>true</moderate>
		</order>
	</ordersession>
...
</orders>
</esc></pre>

===Moderation Level 'Orderline' Sample XML===
Moderate all images associated with a single orderline in a single order.  The sample below is a partial listing of the [XML-Specifications | standard order XML].

<pre><esc>
<?xml version="1.0" encoding="UTF-8"?>
<orders partnerid="xxxxx" version="1">
...
	<ordersession>
		<order>
			<orderid>1234</orderid>
			...
			<orderline productid = "10050" imageid = "5">
				<description>5x7 Glossy Print</description>
				<productprice>1.95</productprice>
				<quantity>1</quantity>
				<position>fit</position>
				<moderate>true</moderate>  
			</orderline>
			...
		</order>
	</ordersession>
...
</orders>
</esc></pre>

===Moderation Level 'Image/Asset' Sample XML===
Moderate a single image, which is associated with one or more orderlines in a single order.  The sample below is a partial listing of the [XML-Specifications | standard order XML].

<pre><esc>
<?xml version="1.0" encoding="UTF-8"?>
<orders partnerid="xxxxx" version="1">
	<images>
		<uri id="3" title="Logo" moderate="true">http://www.ezprints.com/images/logo.jpg</uri>  
		<uri id="5" title="My Photo" moderate="true">http://www.ezprints.com/images/0/0_5.jpg</uri>  <!--Multiple single images per order may be marked for moderation-->
		<uri id="6" title="A  Photo">http://www.ezprints.com/images/0/123.jpg</uri>
	</images>
	...
</orders>
</esc></pre>


===Moderation Level 'Builder Project' Sample XML===
For Builder integrations, moderate one or more images located in the orderline Project XML.  The sample below is a partial listing of the [XML-Specifications | standard order XML].

<pre><esc>
<?xml version="1.0" encoding="UTF-8"?>
<orders partnerid="xxxxx" version="1">
...
	<ordersession>
		<order>
			<orderid>1234</orderid>
			...
			<orderline ProjectId="bea39605-3437-55ca-9999-2223qrt330a30">
				<description>5x7 Glossy Print</description>
				<productprice>1.95</productprice>
				<quantity>1</quantity>
				<position>fit</position>
				<ModerateContent>
				     <Content Id="bb5297b9-434a-048f-ba2a-a3a87a39e3d4" />
				     <Content Id="12345" />
				     <Content Id="c529a7c0-0e40-7e38-fa70-21acdf5ab4c1" />
				</ModerateContent>
			</orderline>
			...
		</order>
	</ordersession>
...
</orders>
</esc></pre>


===Moderated Order-Related XML Nodes and Content===

Listed below is a description of moderation order-related XML nodes and associated content.

{| cellspacing="0" cellpadding="2"
! Element Name !! Child Name !! Element or Attribute? !! Required !! Element Cardinality !! Description<span style="display: block;width: 200px;"></span>
|-
| order
| moderate
| Element
| Optional 
| Only 1
| Indicates whether to moderate all of a single order's images.  Valid values are 'true' or 'false'.  Default is 'false'.
|-
| orderline
| moderate
| Element
| Optional 
| Only 1
| Indicates whether to moderate all of a single orderline's images.  Valid values are 'true' or 'false'.  Default is 'false'.  If an image is shared across multiple orderlines, the image will only be moderated once.
|-
| image
| moderate
| Attribute
| Optional 
| Only 1
| Indicates whether to moderate a single image.  Valid values are 'true' or 'false'.  Default is 'false'.
|-
| orderline
| ModerateContent
| Element
| Optional 
| Only 1
| Indicates to moderate specific images within the <b>Builder</b> project XML for a single orderline.  If orderline/@moderate='true', this value is ignored and all images for an orderline are moderated.  If no child nodes are present, this element is ignored.  Applies only to the project corresponding to the orderline (i.e., orderline/@ProjectId).
|-
| ModerateContent
| Content
| Element
| Required
| One or more
| Indicates a single <b>Builder</b> project XML content image to moderate.  If orderline/@moderate='true', this value is ignored and all images for an orderline are moderated.  
|-
| ModerateContent/Content
| Id
| Element
| Required
| Only 1
| Indicates a single <b>Builder</b> project XML image's content ID to moderate.  Corresponds to a Content/@Id attribute within the project XML, which is also returned by the Project web service operation 'GetContentForProject'.  If orderline/@moderate='true', this value is ignored and all images for an orderline are moderated.  If an invalid ID is specified, the image will not be moderated.
|}
Meta Keywords:
Meta Description:
Change Comment: